<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>CharIndexTranslator (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="CharIndexTranslator (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CharIndexTranslator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hwpf/model/CachedPropertyNode.html" title="class in org.apache.poi.hwpf.model"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hwpf/model/CHPBinTable.html" title="class in org.apache.poi.hwpf.model"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hwpf/model/CharIndexTranslator.html" target="_top">FRAMES</a></li>
<li><a href="CharIndexTranslator.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hwpf.model</p>
<h2 title="Interface CharIndexTranslator" class="title">Interface CharIndexTranslator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/poi/hwpf/model/TextPieceTable.html" title="class in org.apache.poi.hwpf.model">TextPieceTable</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public interface <strong>CharIndexTranslator</strong></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#getByteIndex(int)">getByteIndex</a></strong>(int&nbsp;charPos)</code>
<div class="block">Calculates the byte index of the given char index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#getCharIndex(int)">getCharIndex</a></strong>(int&nbsp;bytePos)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>This API were based on incorrect assumption that single byte
             offset corresponds to single char offset</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#getCharIndex(int, int)">getCharIndex</a></strong>(int&nbsp;bytePos,
            int&nbsp;startCP)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>This API were based on incorrect assumption that single byte
             offset corresponds to single char offset</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int[][]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#getCharIndexRanges(int, int)">getCharIndexRanges</a></strong>(int&nbsp;startBytePosInclusive,
                  int&nbsp;endBytePosExclusive)</code>
<div class="block">Finds character ranges that includes specified byte range.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#isIndexInTable(int)">isIndexInTable</a></strong>(int&nbsp;bytePos)</code>
<div class="block">Check if index is in table</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#lookIndexBackward(int)">lookIndexBackward</a></strong>(int&nbsp;bytePos)</code>
<div class="block">Return last index <= bytePos that is in table</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/CharIndexTranslator.html#lookIndexForward(int)">lookIndexForward</a></strong>(int&nbsp;bytePos)</code>
<div class="block">Return first index >= bytePos that is in table</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getByteIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteIndex</h4>
<pre>int&nbsp;getByteIndex(int&nbsp;charPos)</pre>
<div class="block">Calculates the byte index of the given char index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>charPos</code> - The char position</dd>
<dt><span class="strong">Returns:</span></dt><dd>The byte index</dd></dl>
</li>
</ul>
<a name="getCharIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharIndex</h4>
<pre>@Deprecated
int&nbsp;getCharIndex(int&nbsp;bytePos)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This API were based on incorrect assumption that single byte
             offset corresponds to single char offset</i></div>
<div class="block">Calculates the char index of the given byte index. Look forward if index
 is not in table</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytePos</code> - The character offset to check</dd>
<dt><span class="strong">Returns:</span></dt><dd>the char index</dd></dl>
</li>
</ul>
<a name="getCharIndex(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharIndex</h4>
<pre>@Deprecated
int&nbsp;getCharIndex(int&nbsp;bytePos,
                          int&nbsp;startCP)</pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>This API were based on incorrect assumption that single byte
             offset corresponds to single char offset</i></div>
<div class="block">Calculates the char index of the given byte index.
 Look forward if index is not in table</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytePos</code> - The character offset to check</dd><dd><code>startCP</code> - look from this characted position</dd>
<dt><span class="strong">Returns:</span></dt><dd>the char index</dd></dl>
</li>
</ul>
<a name="getCharIndexRanges(int, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCharIndexRanges</h4>
<pre>int[][]&nbsp;getCharIndexRanges(int&nbsp;startBytePosInclusive,
                         int&nbsp;endBytePosExclusive)</pre>
<div class="block">Finds character ranges that includes specified byte range.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startBytePosInclusive</code> - start byte range</dd><dd><code>endBytePosExclusive</code> - end byte range</dd></dl>
</li>
</ul>
<a name="isIndexInTable(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isIndexInTable</h4>
<pre>boolean&nbsp;isIndexInTable(int&nbsp;bytePos)</pre>
<div class="block">Check if index is in table</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytePos</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>true if index in table, false if not</dd></dl>
</li>
</ul>
<a name="lookIndexForward(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookIndexForward</h4>
<pre>int&nbsp;lookIndexForward(int&nbsp;bytePos)</pre>
<div class="block">Return first index >= bytePos that is in table</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytePos</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>first index greater or equal to bytePos that is in table</dd></dl>
</li>
</ul>
<a name="lookIndexBackward(int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>lookIndexBackward</h4>
<pre>int&nbsp;lookIndexBackward(int&nbsp;bytePos)</pre>
<div class="block">Return last index <= bytePos that is in table</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytePos</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>last index less of equal to bytePos that is in table</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CharIndexTranslator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hwpf/model/CachedPropertyNode.html" title="class in org.apache.poi.hwpf.model"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hwpf/model/CHPBinTable.html" title="class in org.apache.poi.hwpf.model"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hwpf/model/CharIndexTranslator.html" target="_top">FRAMES</a></li>
<li><a href="CharIndexTranslator.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
